Skip to content

Start working on Migration Guide #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 11 commits into from
Mar 15, 2020
Merged

Start working on Migration Guide #50

merged 11 commits into from
Mar 15, 2020

Conversation

sdras
Copy link
Member

@sdras sdras commented Mar 8, 2020

This is a very rough draft start for us to build on top of. I've put in extensive todos so that we can easily see what's stubbed out. It helps to see things as they will come out holistically eventually this way, though.

So far I've worked on:

  • FAQ
  • Built-in Directives
  • Custom Directives

Stopping before I go further because I'd like to hear what the rest of the team thinks (I have some proposals as well) before we go further.

Aside from these changes:

  • Vue Docs Writing Guide

@sdras
Copy link
Member Author

sdras commented Mar 8, 2020

Looks like I need to add in a .gitignore for those DS_store files

@phanan
Copy link
Member

phanan commented Mar 8, 2020

Looks like I need to add in a .gitignore for those DS_store files

They should go into your global ignore file :)

@NataliaTepluhina
Copy link
Member

NataliaTepluhina commented Mar 10, 2020 •
edited
Loading

@sdras should we mention changes to mounting app? I.e. new Vue().$mount -> Vue.createApp({}).mount('#app')?

@sdras
Copy link
Member Author

sdras commented Mar 12, 2020

Looks like I need to add in a .gitignore for those DS_store files

They should go into your global ignore file :)

I actually keep it this way so I can notice which repos are not .gitignoring properly, such as ours :) I'll put in a good one in the next commit.

@sdras
Copy link
Member Author

sdras commented Mar 12, 2020

@sdras should we mention changes to mounting app? I.e. new Vue().$mount -> Vue.createApp({}).mount('#app')?

Yep, that's to come! As mentioned in the details of this PR, I'm not doing it all at once, so that it's easier to see what changed. Big honking PRs are often harder to review and merge. :)

@sdras
Copy link
Member Author

sdras commented Mar 14, 2020

Ok, put in a more healthy .gitignore, and fixed up the merge conflicts, let me know what you think :) if it's ready to keep working on, I'll keep adding more of the migration guide from here

bencodezen
bencodezen reviewed Mar 14, 2020
View reviewed changes
src/guide/writing-guide.md

### Books

- [On Writing Well](https://www.amazon.com/Writing-Well-30th-Anniversary-Nonfiction-ebook/dp/B0090RVGW0) (see [popular quotes](https://www.goodreads.com/work/quotes/1139032-on-writing-well-the-classic-guide-to-writing-nonfiction))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love that you added these resources here!

bencodezen
bencodezen reviewed Mar 14, 2020
View reviewed changes
src/guide/writing-guide.md
@@ -0,0 +1,96 @@
# Vue Docs Writing Guide

Writing documentation is an exercise in empathy. We're not describing an objective reality - the source code already does that. Our job is to help shape the relationship between users and the Vue ecosystem. This ever-evolving guide provides some rules and recommendations on how to do that consistently within the Vue ecosystem.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So much love for this ❤️

bencodezen
bencodezen approved these changes Mar 14, 2020
View reviewed changes
Copy link
Member

@bencodezen bencodezen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is a great start on the migration guide. I'll save more nuanced phrasing and stuff for later as we get closer to the end, but I'm good from my end on merging and continuing to iterate!

@sdras sdras merged commit c825a40 into master Mar 15, 2020
@NataliaTepluhina NataliaTepluhina deleted the migration-start branch July 17, 2020 14:40
@rbattiato rbattiato mentioned this pull request Apr 25, 2021
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bencodezen bencodezen bencodezen approved these changes

@NataliaTepluhina NataliaTepluhina NataliaTepluhina approved these changes

@phanan phanan Awaiting requested review from phanan

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@sdras @phanan @NataliaTepluhina @bencodezen